package risoe.syslab.fhnew.gui;

/*
 * Copyright (c) 2012-2014, Technical University of Denmark (DTU)
 * All rights reserved.
 * 
 * The Flexhouse 2.0 platform ("this software") is licensed under the
 * BSD 3-clause license.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of DTU nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE TECHNICAL UNIVERSITY OF DENMARK BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import java.rmi.Remote;
import java.rmi.RemoteException;

/**
 * The remote interface for use with the UIController
 * @author M. Svendsen
 */
public interface UIManagerRemoteInterface extends Remote {

	/**
	 * Registers a remote UIViewer with the UIManager. Calling this method will result
	 * in all available documents being passed back to the remote UIViewer for initialization.
	 * @param viewer the remote UIViewer to register
	 * @throws RemoteException is thrown if the UIManager has been terminated
	 */
	public void addRemoteViewer(UIViewerRemoteInterface viewer) throws RemoteException;

	/**
	 * Called when a registered UIViewer has obtained an event as the result of user input, 
	 * such as a mouse click or drag.
	 * @param event the VisualizationEvent that was created as the result of user input
	 * @throws RemoteException is thrown if the UIManager has been terminated
	 */
	public void onVisualizationEvent(VisualizationEvent event) throws RemoteException;
	
	/**
	 * Called by a UIViever to obtain a serialized version of a SVG Document
	 * @param visualizationName the name for which a document should be obtained
	 * @return a string representing a serialized version of a SVG Document
	 * @throws RemoteException is thrown if the UIManager has been terminated
	 */
	public String getSerializedDocument(String visualizationName) throws RemoteException;
	
	/**
	 * Called by child UIViewers to ascertain the state of a UIManager
	 * @return true if the UIManager is still alive
	 * @throws RemoteException is thrown if the UIManager has been terminated
	 */
	public boolean issueHeartBeat() throws RemoteException;
}
